Documentation for class scrolling_gadget

Inherits from 	gadget 

Properties declared in scrolling_gadget 
	border_type 
	dynamic_scrolling 
	horizontal_scroller_required 
	line_scroll_amount 
	page_scroll_amount 
	scroll_x 
	scroll_y 
	vertical_scroller_required 

Class Methods declared in scrolling_gadget 
	new 

Methods declared in scrolling_gadget 
	action 
		scroll_to_top
	any 
		border_type 
		dynamic_scrolling 
		horizontal_scroller_required 
		line_scroll_amount 
		page_scroll_amount 
		scroll_by(dx, dy) 
		scroll_to(x, y) 
		scroll_to_top
		scroll_x 
		scroll_y 
		set_border_type(type) 
		set_dynamic_scrolling(boolean) 
		set_horizontal_scroller_required(boolean) 
		set_line_scroll_amount(number) 
		set_page_scroll_amount(number) 
		set_vertical_scroller_required(boolean) 
		vertical_scroller_required 
	get 
		border_type 
		dynamic_scrolling 
		horizontal_scroller_required 
		line_scroll_amount 
		page_scroll_amount 
		scroll_x 
		scroll_y 
		vertical_scroller_required 
	set 
		set_border_type(type) 
		set_dynamic_scrolling(boolean) 
		set_horizontal_scroller_required(boolean) 
		set_line_scroll_amount(number) 
		set_page_scroll_amount(number) 
		set_vertical_scroller_required(boolean) 

Class 
#begin_class
scrolling_gadget 
The class scrolling_gadget is a subclass of the class gadget. 
The class scrolling_gadget is a so-called abstract class. It implements the methods that is shared by scroller and word processor. 
Note: You cannot create instances of an abstract class.
#end_class

Properties 

#begin_property
border_type 
Stores the border-type of the scrolling gadget. 
The different border-types are:
#no_border
#border
#gray_bezel_border
#end_property

#begin_property
dynamic_scrolling 
Stores a boolean value. If it is true the scrolling gadget will scroll continuously when the scroll-bars are dragged.
If it is false the scroll will show first when the scroll-bar is released.
The default value is true.
#end_property

#begin_property
horizontal_scroller_required 
Stores a boolean value. If it is true the horizontal scroll-bar will be visible.
The default value is true.
#end_property

#begin_property
line_scroll_amount 
Stores the amount to scroll the content-slide when the scrolling gadget receives a message to scroll one line. (I.e. the arrow button in the scroll-bar is clicked).
The default value is 10.
#end_property

#begin_property
page_scroll_amount 
Stores the amount to scroll the content-slide when the scrolling gadget receives a message to scroll one page. (I.e. the arrow button in the scroll-bar is clicked with the alt-key pressed). 
A value of 0 implies that the entire content-slide is replaced when a page scroll occurs. 
A higher value will make the new portion of the content-slide overlap the old portion with that value.
The default value is 10.
#end_property

#begin_property
scroll_x 
Stores how much the scrolling gadget is scrolled horizontally.
#end_property

#begin_property
scroll_y 
Stores how much the scrolling gadget is scrolled vertically.
#end_property

#begin_property
vertical_scroller_required 
Stores a boolean value. If it is true the vertical scroll-bar will be visible.
The default value is true.
#end_property

Methods 

#begin_method
border_type 
Returns the border_type property of the scroller.
#end_method

#begin_method
dynamic_scrolling 
Returns the dynamic_scrolling property of the scrolling gadget.
#end_method

#begin_method
horizontal_scroller_required 
Returns the horizontal_scroller_required property of the scrolling gadget.
#end_method

#begin_method
line_scroll_amount 
Returns the line_scroll_amount property of the scrolling gadget.
#end_method

#begin_method
page_scroll_amount 
Returns the page_scroll_amount property of the scrolling gadget.
#end_method

#begin_method
scroll_by(dx, dy) 
Changes the scroll of the scrolling gadget by dx and dy.
Returns self.
Also see scroll_to(x, y).
#end_method

#begin_method
scroll_to(x, y) 
Scrolls the scrolling gadget to the position (x, y).
Returns self.
Also see scroll_by(dx, dy).
#end_method

#begin_method
scroll_to_top 
Scrolls the scrolling gadget so that the horizontal scroll-bar is to the left and the vertical scroll-bar is to the top.
This is equal to self:scroll_to(0, self:content_slide:height).
Returns self.
#end_method

#begin_method
scroll_x 
Returns the scroll_x property of the scrolling gadget.
#end_method

#begin_method
scroll_y 
Returns the scroll_y property of the scrolling gadget.
#end_method

#begin_method
set_border_type(type) 
Sets the border_type property to type.
The different border-types are:
#no_border
#border
#gray_bezel_border
Returns self.
#end_method

#begin_method
set_dynamic_scrolling(boolean) 
Sets the dynamic_scrolling property to boolean.
Returns self.
#end_method

#begin_method
set_horizontal_scroller_required(boolean) 
Sets the horizontal_scroller_required property to boolean.
Returns self.
#end_method

#begin_method
set_line_scroll_amount(number) 
Sets the line_scroll_amount property to number.
Returns self.
#end_method

#begin_method
set_page_scroll_amount(number) 
Sets the page_scroll_amount property to number.
Returns self.
#end_method

#begin_method
set_vertical_scroller_required(boolean) 
Sets the vertical_scroller_required property to boolean.
Returns self.
#end_method

#begin_method
vertical_scroller_required 
Returns the vertical_scroller_required property of the scrolling gadget.
#end_method

Class Methods 

#begin_class_method
new 
You cannot create instances of the class scrolling gadget since it is an abstract class.
Ex:
{scrolling_gadget}:new
raises an exception
Exception:
The message new was sent to the class scrolling_gadget but scrolling_gadget is an abstract class which you can't make instances of
#end_class_method